org.globalplatform
Interface GPRegistryEntry

All Superinterfaces:

javacard.framework.Shareable

public interface GPRegistryEntry
extends javacard.framework.Shareable

This defines the interface corresponding to the GPRegistryEntry of a single Application. The Global Service Application uses this interface to check the validity of the request presented by an on-card entity. Prior to using this interface, an Application is required to obtain a handle to the GPRegistryEntry of an Application by invoking the GPSystem.getRegistryEntry() method.

Since:

export file version 1.1

Field Summary

static byte	PRIVILEGE_AUTHORIZED_MANAGEMENT Privilege indicating Authorized Management (0x09).
static byte	PRIVILEGE_CARD_LOCK Privilege indicating Card Lock (0x03).
static byte	PRIVILEGE_CARD_RESET Privilege indicating Card Reset (0x05).
static byte	PRIVILEGE_CARD_TERMINATE Privilege indicating Card Terminate (0x04).
static byte	PRIVILEGE_CIPHERED_LOAD_FILE_DATA_BLOCK Privilege indicating Ciphered Load File Data Block (0x11).
static byte	PRIVILEGE_CVM_MANAGEMENT Privilege indicating CVM Management (0x06).
static byte	PRIVILEGE_DAP_VERIFICATION Privilege indicating DAP verification (0x01).
static byte	PRIVILEGE_DELEGATED_MANAGEMENT Privilege indicating Delegated Management (0x02).
static byte	PRIVILEGE_FINAL_APPLICATION Privilege indicating Final Application (0x0E).
static byte	PRIVILEGE_GLOBAL_DELETE Privilege indicating Global Delete (0x0B).
static byte	PRIVILEGE_GLOBAL_LOCK Privilege indicating Global Lock (0x0C).
static byte	PRIVILEGE_GLOBAL_REGISTRY Privilege indicating Global Registry (0x0D).
static byte	PRIVILEGE_GLOBAL_SERVICE Privilege indicating Global Service (0x0F).
static byte	PRIVILEGE_MANDATED_DAP Privilege indicating Mandated DAP verification privilege (0x07).
static byte	PRIVILEGE_RECEIPT_GENERATION Privilege indicating Receipt Generation (0x10).
static byte	PRIVILEGE_SECURITY_DOMAIN Privilege indicating application is a Security Domain (0x00).
static byte	PRIVILEGE_TOKEN_VERIFICATION Privilege indicating Token Verification (0x0A).
static byte	PRIVILEGE_TRUSTED_PATH Privilege indicating Trusted Path (0x08).

Method Summary

void	deregisterService(short sServiceName) This method allows a Global Services Application (e.g. a CVM Application) to deregister a service name.
javacard.framework.AID	getAID() This method returns the Application's AID registered in the current GlobalPlatform Registry's entry.
short	getPrivileges(byte[] baBuffer, short sOffset) This method returns all the Privileges bytes registered in the current GlobalPlatform registry entry.
byte	getState() This method returns the Life Cycle State registered in the current GlobalPlatform Registry entry.
boolean	isAssociated(javacard.framework.AID SDAID) This method allows to verify if the entity whose AID is provided in the input parameters is registered as the associated Security Domain of this GPRegistryEntry.
boolean	isPrivileged(byte bPrivilege) This method allows an Application (e.g. a CVM Application) to verify if a given Privilege is registered in this GPRegistryEntry (e.g. check the CVM Management privilege of another Application invoking the CVM.update() method).
void	registerService(short sServiceName) This method allows a Global Services Application (e.g. a CVM Application) to register a unique service identifier within the GlobalPlatform Registry.
boolean	setState(byte bState) This method allows the Life Cycle state of this GPRegistryEntry to be transitioned to the requested target state.

Field Detail

PRIVILEGE_AUTHORIZED_MANAGEMENT

static final byte PRIVILEGE_AUTHORIZED_MANAGEMENT

Privilege indicating Authorized Management (0x09).

See Also:

Constant Field Values

PRIVILEGE_CARD_LOCK

static final byte PRIVILEGE_CARD_LOCK

Privilege indicating Card Lock (0x03).

See Also:

Constant Field Values

PRIVILEGE_CARD_RESET

static final byte PRIVILEGE_CARD_RESET

Privilege indicating Card Reset (0x05).

See Also:

Constant Field Values

PRIVILEGE_CARD_TERMINATE

static final byte PRIVILEGE_CARD_TERMINATE

Privilege indicating Card Terminate (0x04).

See Also:

Constant Field Values

PRIVILEGE_CVM_MANAGEMENT

static final byte PRIVILEGE_CVM_MANAGEMENT

Privilege indicating CVM Management (0x06).

See Also:

Constant Field Values

PRIVILEGE_DAP_VERIFICATION

static final byte PRIVILEGE_DAP_VERIFICATION

Privilege indicating DAP verification (0x01).

See Also:

Constant Field Values

PRIVILEGE_DELEGATED_MANAGEMENT

static final byte PRIVILEGE_DELEGATED_MANAGEMENT

Privilege indicating Delegated Management (0x02).

See Also:

Constant Field Values

PRIVILEGE_FINAL_APPLICATION

static final byte PRIVILEGE_FINAL_APPLICATION

Privilege indicating Final Application (0x0E).

See Also:

Constant Field Values

PRIVILEGE_GLOBAL_DELETE

static final byte PRIVILEGE_GLOBAL_DELETE

Privilege indicating Global Delete (0x0B).

See Also:

Constant Field Values

PRIVILEGE_GLOBAL_LOCK

static final byte PRIVILEGE_GLOBAL_LOCK

Privilege indicating Global Lock (0x0C).

See Also:

Constant Field Values

PRIVILEGE_GLOBAL_REGISTRY

static final byte PRIVILEGE_GLOBAL_REGISTRY

Privilege indicating Global Registry (0x0D).

See Also:

Constant Field Values

PRIVILEGE_GLOBAL_SERVICE

static final byte PRIVILEGE_GLOBAL_SERVICE

Privilege indicating Global Service (0x0F).

See Also:

Constant Field Values

PRIVILEGE_MANDATED_DAP

static final byte PRIVILEGE_MANDATED_DAP

Privilege indicating Mandated DAP verification privilege (0x07).

See Also:

Constant Field Values

PRIVILEGE_RECEIPT_GENERATION

static final byte PRIVILEGE_RECEIPT_GENERATION

Privilege indicating Receipt Generation (0x10).

See Also:

Constant Field Values

PRIVILEGE_SECURITY_DOMAIN

static final byte PRIVILEGE_SECURITY_DOMAIN

Privilege indicating application is a Security Domain (0x00).

See Also:

Constant Field Values

PRIVILEGE_TOKEN_VERIFICATION

static final byte PRIVILEGE_TOKEN_VERIFICATION

Privilege indicating Token Verification (0x0A).

See Also:

Constant Field Values

PRIVILEGE_TRUSTED_PATH

static final byte PRIVILEGE_TRUSTED_PATH

Privilege indicating Trusted Path (0x08).

See Also:

Constant Field Values

PRIVILEGE_CIPHERED_LOAD_FILE_DATA_BLOCK

static final byte PRIVILEGE_CIPHERED_LOAD_FILE_DATA_BLOCK

Privilege indicating Ciphered Load File Data Block (0x11).

See Also:

Constant Field Values

Method Detail

deregisterService

void deregisterService(short sServiceName)
                       throws javacard.framework.ISOException

This method allows a Global Services Application (e.g. a CVM Application) to deregister a service name.

Notes:

• The OPEN checks that the requesting on-card entity has the Global Service Privilege and is associated with this registry entry;
• The OPEN checks that the service name is registered as unique for the requesting on-card entity.

Parameters:

sServiceName - the unique service name to deregister.

Throws:

javacard.framework.ISOException - with the following reason code:

ISO7816.SW_CONDITIONS_NOT_SATISFIED

getAID

javacard.framework.AID getAID()

This method returns the Application's AID registered in the current GlobalPlatform Registry's entry.

Notes:

• The OPEN checks that the requesting on-card entity has the Global Service Privilege and is associated with this registry entry;
• The OPEN checks that the service name is registered as unique for the requesting on-card entity.

Returns:

the AID object.

getPrivileges

short getPrivileges(byte[] baBuffer,
                    short sOffset)
                    throws java.lang.ArrayIndexOutOfBoundsException

This method returns all the Privileges bytes registered in the current GlobalPlatform registry entry.

Parameters:

baBuffer - The byte array where Privileges bytes are to be stored.

sOffset - The offset in baBuffer at which to begin the Privileges bytes.

Returns:

sOffset + Length of the Privileges.

Throws:

java.lang.ArrayIndexOutOfBoundsException -

if storing the Privileges bytes would cause access outside array bounds or the sOffset is negative.

getState

byte getState()

This method returns the Life Cycle State registered in the current GlobalPlatform Registry entry.

Returns:

The Life Cycle State as defined in section 11.11.

isAssociated

boolean isAssociated(javacard.framework.AID SDAID)

This method allows to verify if the entity whose AID is provided in the input parameters is registered as the associated Security Domain of this GPRegistryEntry.

Notes:

• The OPEN determines if the SDAID is registered in the current GlobalPlatform Registry's entry as the associated Security Domain.

Parameters:

SDAID - object of the investigated Security Domain.

Returns:

True if the GP Registry references the Security Domain as being associated with this GPRegistryEntry, or False otherwise

isPrivileged

boolean isPrivileged(byte bPrivilege)

This method allows an Application (e.g. a CVM Application) to verify if a given Privilege is registered in this GPRegistryEntry (e.g. check the CVM Management privilege of another Application invoking the CVM.update() method).

Parameters:

bPrivilege - the privilege number to verify, as defined in Table 6-1.

Returns:

True if at least the referenced Privilege is registered in the GP Registry entry, or False if the referenced Privilege is not registered in the GP Registry entry.

registerService

void registerService(short sServiceName)
                     throws javacard.framework.ISOException

This method allows a Global Services Application (e.g. a CVM Application) to register a unique service identifier within the GlobalPlatform Registry.

Notes:

• The OPEN checks that the requesting on-card entity has the Global Service Privilege and is associated with the current GlobalPlatform Registry entry;
• The OPEN checks that the requested service identifier matches with (one of) the Service Parameter(s) recorded in the current GlobalPlatform Registry entry;
• The OPEN checks that the service identifier is not already registered as unique by any other entry in the GlobalPlatform Registry.

Parameters:

sServiceName - the unique service name to register.

Throws:

javacard.framework.ISOException - with the following reason code:

ISO7816.SW_CONDITIONS_NOT_SATISFIED

setState

boolean setState(byte bState)

This method allows the Life Cycle state of this GPRegistryEntry to be transitioned to the requested target state.

Notes:

• A transition request to the Life Cycle State INSTALLED shall be rejected;
• A transition request to Life Cycle state other than APPLICATION_LOCKED and APPLICATION_UNLOCKED shall be accepted only if the invoking Application corresponds to this GPRegistryEntry;
• An Application shall be able to lock and shall not be able to unlock itself;
• Only an Application with GlobalLock privilege or the directly or indirectly associated Security Domain of this GPRegistryEntry shall be able to lock or unlock this GPRegistry Entry;
• This method shall fail if this GPRegsitryEntry corresponds to the Issuer Security Domain.

Parameters:

bState - the target state for this GPRegistryEntry.

Returns:

True if the transition is successful, or False otherwise.